<html>
<head><meta charset="utf-8"><title>Document clippy config · clippy · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/index.html">clippy</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html">Document clippy config</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="243904869"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243904869" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> DevinR528 <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243904869">(Jun 25 2021 at 11:49)</a>:</h4>
<p>I was looking around for clippy's equivalent of the <a href="https://rust-lang.github.io/rustfmt/?version=v1.4.36&amp;search=">rustfmt config docs</a> but ended up looking at the <code>Conf</code> struct code as the easiest way to see all the config options. I do see that the lint list web page has this information but I feel like it would be valuable to have it condensed so users are able to see all the configurable things.</p>



<a name="243906432"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243906432" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> flip1995 <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243906432">(Jun 25 2021 at 12:06)</a>:</h4>
<p>Good point. Since we're currently in the process of generally improving our documentation, we could indeed add this. There's currently the Clippy book PR open, that is blocked by me and my Clippy TODO list/queue. But I can see this configuration documentation as a chapter in the Clippy book.</p>



<a name="243906761"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243906761" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> flip1995 <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243906761">(Jun 25 2021 at 12:10)</a>:</h4>
<p>I really want to do this, after we got a first version of the book. If we rush it now, we'd have to implement automation for it now and then potentially re-do the automation once again when we restructured our documentation.</p>
<p>Hope that makes sense.</p>



<a name="243906783"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243906783" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> xFrednet <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243906783">(Jun 25 2021 at 12:10)</a>:</h4>
<p>Yes, this is currently a bit of a pain point. The configuration documentation is currently only exported as part of the lint documentation (<a href="https://rust-lang.github.io/rust-clippy/master/index.html#boxed_local">Example</a>). I plan to add a new part to the website that lists all configuration values with links to the effected lints once the new metadata collection is merged. The implementation already collects all configurations and should allow an easy export of them.</p>



<a name="243906908"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243906908" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> flip1995 <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243906908">(Jun 25 2021 at 12:11)</a>:</h4>
<p>I wouldn't add this to the website. I would just add it to the Clippy book. We don't have that many configurations, so I don't think we need an extra website for it.</p>



<a name="243907169"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243907169" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> xFrednet <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243907169">(Jun 25 2021 at 12:14)</a>:</h4>
<p>That works for me. I'm happy to take over the automation once the book is ready for it. :)</p>



<a name="243977518"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/257328-clippy/topic/Document%20clippy%20config/near/243977518" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> DevinR528 <a href="https://rust-lang.github.io/zulip_archive/stream/257328-clippy/topic/Document.20clippy.20config.html#243977518">(Jun 25 2021 at 22:21)</a>:</h4>
<p>Cool yeah sounds good! If there is anything I can do to help everything along I'm game.</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>